--[[
  namespace: ~Virtual Table

  List of all documented virtual tables with a brief descriptions of each.
]]


--[[
  type: color

  Represents the color property.

  Key-Value Pairs::
  r - (*8-bit unsigned int*) Red color composition (Range: 0 ~ 255).
  g - (*8-bit unsigned int*) Green color composition (Range: 0 ~ 255).
  b - (*8-bit unsigned int*) Blue color composition (Range: 0 ~ 255).
]]


--[[
  type: size

  Represents the dimension of an object.

  Key-Value Pairs::
  width  - (*int*) Width of the size.
  height - (*int*) Height of the size.
]]


--[[
  type: vector3D

  Represents the 3D vector.

  Key-Value Pairs::
  x - (*number / int*) X coordinate.
  y - (*number / int*) Y coordinate.
  z - (*number / int*) Z coordinate.
]]


--[[
  type: weaponList

  Represents the generic weapon list.

  This table can contains multiple key-value pairs::

  Key-Value Pairs::
  int index         - (*int*) one of <Common.WEAPON>.
  another int index - (*int*) another one of <Common.WEAPON>.
  another int index - (*int*) another one of <Common.WEAPON>.
  ...               - *...*
]]


--[[
  type: UIBoxSetArg

  Represents the property/setting table for <UI.Box> objects.

  Key-Value Pairs::
  x      - (*int*) (Optional) X coordinate on screen.
  y      - (*int*) (Optional) Y coordinate on screen.
  width  - (*int*) (Optional) Width of the box.
  height - (*int*) (Optional) Height of the box.
  r      - (*8-bit unsigned int*) (Optional) Red color composition (Range: 0 ~ 255).
  g      - (*8-bit unsigned int*) (Optional) Green color composition (Range: 0 ~ 255).
  b      - (*8-bit unsigned int*) (Optional) Blue color composition (Range: 0 ~ 255).
  a      - (*8-bit unsigned int*) (Optional) Transparency composition (Range: 0 ~ 255).
]]


--[[
  type: UITextSetArg

  Represents the property/setting table for <UI.Text> objects.

  Key-Value Pairs::
  text   - (*string*) (Optional) Text to display on screen.
  font   - (*string*) (Optional) Font size (Option: small / medium / large / verylarge).
  align  - (*string*) (Optional) Text alignment (Option: left / center / right).
  x      - (*int*) (Optional) X coordinate on screen.
  y      - (*int*) (Optional) Y coordinate on screen.
  width  - (*int*) (Optional) Width of the text box boundary.
  height - (*int*) (Optional) Height of the text box boundary.
  r      - (*8-bit unsigned int*) (Optional) Red color composition (Range: 0 ~ 255).
  g      - (*8-bit unsigned int*) (Optional) Green color composition (Range: 0 ~ 255).
  b      - (*8-bit unsigned int*) (Optional) Blue color composition (Range: 0 ~ 255).
  a      - (*8-bit unsigned int*) (Optional) Transparency composition (Range: 0 ~ 255).
]]


--[[
  type: UIKeyState

  Represents the collection of all active key states.

  This table can contains multiple key-value pairs::

  Key-Value Pairs::
  one of <UI.KEY>         - (*bool*) true (Active) / false or nil (Inactive).
  another one of <UI.KEY> - (*bool*) true (Active) / false or nil (Inactive).
  another one of <UI.KEY> - (*bool*) true (Active) / false or nil (Inactive).
  ...                     - *...*
]]


--[[
  type: GameEntityBlockEventArg

  Represents the event argument table for <Game.EntityBlock.Event> method.

  Key-Value Pairs::
  action - (*string*) Event name to raise.
  value  - (*?*) (Optional) Value to send.

  Available event(s) to raise::

  Use::
  action - "use"
  value  - (*nil*)

  Touch::
  action - "touch"
  value  - (*nil*)

  Reset::
  action - "reset"
  value  - (*nil*)

  Send activation signal::
  Undocumented in official website::
  action - "signal"
  value  - (*bool*) true (Turn on) / false or nil (Turn off).

  Change the text (for textboard blocks)::
  Undocumented in official website::
  action - "text"
  value  - (*string*) The display text.
]]

